Disable ForeignHandler by default and add command console:toggle-echo to enable ForeighHandler through context menu #4503

BoPeng · 2018-05-01T02:50:06Z

This patch disables ForeignHandler in console window by default so expressions evaluated in notebooks will not be echoed in associated console window. A command console:toggle-echo is added to the context menu to allow echo.

See details in #4424

… to enable ForeighHandler through context menu jupyterlab#4424

jasongrout

Thanks! I've noted some things inline. This was surprisingly straightforward - a testament to @afshin's design.

jasongrout · 2018-05-01T04:50:49Z

packages/console-extension/src/index.ts

@@ -399,6 +402,17 @@ function activateConsole(app: JupyterLab, mainMenu: IMainMenu, palette: ICommand
    isEnabled
  });

+  commands.addCommand(CommandIDs.toggleEcho, {
+    label: 'Toggle echo…',


We reserve the ellipsis for commands that require further confirmation, like a dialog box. Since this doesn't require further confirmation, we shouldn't have the ellipsis here.

jasongrout · 2018-05-01T04:52:31Z

tests/test-console/src/foreign.spec.ts

@@ -148,7 +148,7 @@ describe('@jupyterlab/console', () => {
    describe('#enabled', () => {

      it('should default to `true`', () => {
-        expect(handler.enabled).to.be(true);
+        expect(handler.enabled).to.be(false);


Test label is now 'should default to `false`'

The test below should probably explicitly set handler.enabled = true, right?

Yes, you are right. handler.enabled = true; is added below.

jasongrout

Sorry, somehow I didn't submit my biggest comment.

jasongrout · 2018-05-01T05:03:38Z

packages/console/src/widget.ts

+   * Toggle ForeignHandler
+   */
+  toggleForeignHandler() {
+    this._foreignHandler.enabled = ! this._foreignHandler.enabled;


Instead of a toggle, can we just expose this boolean attribute using a get/set pair? Maybe it could be named .echoForeignData or simply just .echo - not sure about a good name?

I think the toggling logic should be in the command, and at this level, it makes more sense to have the strictly more general get/set pair creating a new attribute exposing the enabled attribute.

BoPeng · 2018-05-01T14:48:00Z

PR revised according to @jasongrout 's comments. Tests failed due to some sort of timeout error, which I do not know how to address.

jasongrout · 2018-05-01T17:12:51Z

I slept on the name - how about .showAllActivity instead of .echoEnabled? I think it conveys what is happening - echo often means sending something right back, but we aren't sending anything back. Similarly, we can call the menu item Toggle showing all kernel activity or something.

Even better would be calling the menu item "Show all [kernel?] activity", but I think the command palette doesn't support having a checkmark showing state next to an item? @sccolbert, @ian-r-rose?

ian-r-rose · 2018-05-01T17:18:38Z

@jasongrout That's right. Since the command palette doesn't render check marks, we have used that pattern in a bunch of places. It is accomplished by passing in an isPalette arg to the command, and conditionally rendering the label:

jupyterlab/packages/application-extension/src/index.tsx

Lines 280 to 285 in afe47dd

    
           command = CommandIDs.toggleLeftArea; 
        
           app.commands.addCommand(command, { 
        
             label: args => args['isPalette'] ? 
        
             'Toggle Left Area' : 'Show Left Area', 
        
             execute: () => {

I like Show all kernel activity / Toggle showing all kernel activity.

ian-r-rose · 2018-05-01T17:20:19Z

Note that the isPalette pattern can cause problems with the rendering of keyboard shortcuts (phosphorjs/phosphor#325)

BoPeng · 2018-05-01T17:22:23Z

Show all kernel activity is good, but Toggle showing all kernel activity is kind of long. How does Show only console activity sound?

jasongrout · 2018-05-01T17:36:05Z

Hmmm - then it sounds to me like the default should be showing all activity, and you should check the box to narrow to just this console. And it's a bit confusing if you have two consoles sending things to the same kernel - it sounds a bit like it should show all activity from any console.

The other thing I thought of was something along the lines of "Show other activity" - but I like your concentration on showing just my activity language over the word "other".

jasongrout · 2018-05-01T17:37:26Z

@sccolbert - how hard would it be to show the state as a checkmark in the command palette, like in the menus?

ellisonbg · 2018-05-01T18:04:30Z

The issue I see with the phrasing that emphasizes "my" or "this" is that a user probably won't have any idea what the "other" is. Even "other activity" isn't really descriptive as to what that "other" thing is. I would prefer something more descriptive to the user that also addresses the usability of the changed default, like "show all kernel activity from all attached notebooks/consoles." I know that is too long...

jasongrout · 2018-05-01T18:21:50Z

"Show all other kernel activity"?

ellisonbg · 2018-05-01T18:23:57Z

Yes, that is great!

…

On Tue, May 1, 2018 at 11:21 AM, Jason Grout ***@***.***> wrote: "Show all other kernel activity"? — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#4503 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABr0PwBsXqv8z0WgELQpJoYXZV-02deks5tuKe-gaJpZM4TtgbZ> .

-- Brian E. Granger Associate Professor of Physics and Data Science Cal Poly State University, San Luis Obispo @ellisonbg on Twitter and GitHub bgranger@calpoly.edu and ellisonbg@gmail.com

…option

BoPeng · 2018-05-01T20:39:18Z

I do not see a need to change the label of menu item. Is the following good enough?

Initially state:

After turning on show all other kernel activity:

ian-r-rose · 2018-05-01T20:43:42Z

I am personally not a fan of "other", since it is not especially clear what that is opposed to, but I don't consider that blocking. @BoPeng, can you capitalize the words in the label for consistency with the other menu items?

BoPeng · 2018-05-01T20:45:30Z

Changed but I would vote for "Show All Kernel Activity".

ian-r-rose · 2018-05-01T20:46:56Z

I agree with that.

BoPeng · 2018-05-01T20:49:14Z

Done again. Hopefully this is acceptable to everyone.

BoPeng · 2018-05-01T21:26:48Z

Note that I cannot make change of label work with the following change. args would get {'isPalette': true} the first time and then {} afterwards. Something is missing here although I am ok with a fixed label with check mark.

diff --git a/packages/console-extension/src/index.ts b/packages/console-extension/src/index.ts
index 6835ebae5..3d3b3cf0b 100644
--- a/packages/console-extension/src/index.ts
+++ b/packages/console-extension/src/index.ts
@@ -403,7 +403,8 @@ function activateConsole(app: JupyterLab, mainMenu: IMainMenu, palette: ICommand
   });

   commands.addCommand(CommandIDs.toggleShowAllActivity, {
-    label: args => 'Show All Kernel Activity',
+    //label: args => 'Show All Kernel Activity',
+    label: args => args['isPalette'] ? 'Show All Kernel Activity' : 'Show Only Console Activity',
     execute: args => {
       let current = getCurrent(args);
       if (!current) {

ian-r-rose · 2018-05-01T22:37:01Z

You can make it so that the label is context dependent: the arg isPalette get's passed when you add it to the command palette, and it gets rendered with that argument every time the command palette is rendered:
e.g.:
https://github.com/jupyterlab/jupyterlab/blob/master/packages/application-extension/src/index.tsx#L296

This is only relevant if you are actually adding the command to the command palette, which, as far as I cant tell, you have not done here.

BoPeng · 2018-05-02T01:30:43Z

Line 430 adds toggleShowAllActivity (line 428) to the palette...

When I trace the label function, it was called with args={'isPalette': true} for a while but when I actually right-click, only args={} is passed.

ian-r-rose · 2018-05-02T01:34:09Z

Ah, yes, so it does. If args={} is passed to the command palette, it should show the wrong label. Do you see that happening?

BoPeng · 2018-05-02T01:39:49Z

I see the wrong label (the last part of ? : ) all the time because {} is always passed when I right-click.

ian-r-rose · 2018-05-02T01:45:48Z

I think we are talking past each other: the command palette (the panel in the the left area) is the part that gets the args isPalette: true. This is not the same as the context menu, to which you are not sending any args. So my question is:

What do you want the label for the command palette to be?
What do you want the label for the context menu to be?

If those two things are different, you can try to distinguish between them by passing different args. If they are not, then you don't need to do that.

BoPeng · 2018-05-02T01:50:50Z

Phew, I see what is going on now. We currently have a fixed label Show All Kernel Activity with a checkmark showing the status. I am fine with that but I thought you also suggested the option to show Show All Kernel Activity initially, and change the label to something like Show Only Console Activity after the status is changed to show all activity...

BoPeng · 2018-05-02T01:56:12Z

Now I see that you were not talking about that behavior. Rather to show different labels in context menu and command palette, and there is a problem with showing the status in command palette because the checkmark is not rendered there.

Are we on the same pace now?

ian-r-rose · 2018-05-02T01:58:13Z

Right, that is what I was referring to. Since the command palette does not render checkmarks (at least for now, I would like to change that), the label there would not be really correct. So I am proposing

In the context menu have the label be Show All Kernel Activity with/without a check
In the command palette have the label be Toggle Show All Kernel Activity

…ette

BoPeng · 2018-05-02T02:04:13Z

Done. I suppose that is no remaining issue with this PR.

jasongrout · 2018-05-02T19:19:57Z

Inspired by the confusion here, and the workarounds that @ian-r-rose has had to do as well, perhaps we should merge @ian-r-rose's PR at #4510 first that simplifies the commands added to the palette, and then update this PR.

On the other hand, if this passes tests now, I'm happy to merge it and update the palette command later along with a lot of other commands.

ian-r-rose · 2018-05-02T19:22:52Z

I am happy to do either. If we merge this first, I can update the content here in my PR.

BoPeng · 2018-05-02T19:25:37Z

The tests should pass because the Travis test that failed last time has passed and appvoyer passed last time.

BoPeng · 2018-05-02T20:54:32Z

Long delay at AppVoyer but all tests have passed now.

ian-r-rose · 2018-05-02T21:23:41Z

Thanks @BoPeng, I think this is a nice improvement on the default behavior.

jasongrout · 2018-05-03T00:13:14Z

Thanks again!

BoPeng · 2018-05-03T00:40:28Z

You all are very welcome!

Disable ForeignHandler by default and add command console:toggle-echo…

3689489

… to enable ForeighHandler through context menu jupyterlab#4424

BoPeng mentioned this pull request May 1, 2018

Stop sending output from notebook to console window? #4424

Closed

Fix test for default value of foreignHandler.enabled

0a7daf9

jasongrout requested changes May 1, 2018

View reviewed changes

Implement toggle in extension, and other improvements

59a4d6e

Bo Peng added 3 commits May 1, 2018 15:09

Use AllActivity instead of echo to better describe the effect of the …

4b1d224

…option

Use a fixed label for menu item because of the use of isToggled

180d041

Change the label to Show all other kernel activity

10b74d8

Change the label to Show All Other Kernel Activity

33cba8d

Change the label to Show All Kernel Activity

ae2a6a6

Use label Toggle Show All Kernel Activity for the item in command pal…

03f5dd4

…ette

Bo Peng added 2 commits May 2, 2018 10:21

Fix console tests broken due to default inactive foreignHandler

5c02625

Check tracker.currentWidget in isToggled

6162f3e

ian-r-rose merged commit b36f970 into jupyterlab:master May 2, 2018

BoPeng deleted the toggle-console-echo branch May 3, 2018 00:48

BoPeng mentioned this pull request May 3, 2018

A side panel to display information from all kernels and extensions #4411

Closed

jasongrout added this to the Beta 3 milestone Jun 12, 2018

BoPeng mentioned this pull request Jun 27, 2018

New action runInConsole to allow line by line execution of cell content #4330

Merged

lckr mentioned this pull request Jul 25, 2018

Console Spam jupyterlab-contrib/jupyterlab-variableInspector#31

Closed

blink1073 mentioned this pull request Aug 2, 2018

New Console for Notebook #5028

Closed

BoPeng mentioned this pull request May 8, 2019

A general UI for displaying transient information from kernels #4550

Open

lock bot added the status:resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion. label Aug 8, 2019

lock bot locked as resolved and limited conversation to collaborators Aug 8, 2019

Disable ForeignHandler by default and add command console:toggle-echo to enable ForeighHandler through context menu #4503

Disable ForeignHandler by default and add command console:toggle-echo to enable ForeighHandler through context menu #4503

Conversation

BoPeng commented May 1, 2018

jasongrout left a comment

Choose a reason for hiding this comment

jasongrout May 1, 2018

Choose a reason for hiding this comment

jasongrout May 1, 2018

Choose a reason for hiding this comment

jasongrout May 1, 2018

Choose a reason for hiding this comment

BoPeng May 1, 2018

Choose a reason for hiding this comment

jasongrout left a comment

Choose a reason for hiding this comment

jasongrout May 1, 2018

Choose a reason for hiding this comment

BoPeng commented May 1, 2018

jasongrout commented May 1, 2018

ian-r-rose commented May 1, 2018

ian-r-rose commented May 1, 2018

BoPeng commented May 1, 2018

jasongrout commented May 1, 2018

jasongrout commented May 1, 2018

ellisonbg commented May 1, 2018

jasongrout commented May 1, 2018

ellisonbg commented May 1, 2018 via email

BoPeng commented May 1, 2018 • edited

ian-r-rose commented May 1, 2018

BoPeng commented May 1, 2018

ian-r-rose commented May 1, 2018

BoPeng commented May 1, 2018

BoPeng commented May 1, 2018

ian-r-rose commented May 1, 2018

BoPeng commented May 2, 2018 • edited

ian-r-rose commented May 2, 2018

BoPeng commented May 2, 2018

ian-r-rose commented May 2, 2018

BoPeng commented May 2, 2018 • edited

BoPeng commented May 2, 2018

ian-r-rose commented May 2, 2018

BoPeng commented May 2, 2018

jasongrout commented May 2, 2018

ian-r-rose commented May 2, 2018

BoPeng commented May 2, 2018

BoPeng commented May 2, 2018 • edited

ian-r-rose commented May 2, 2018

jasongrout commented May 3, 2018

BoPeng commented May 3, 2018

BoPeng commented May 1, 2018 •

edited

BoPeng commented May 2, 2018 •

edited

BoPeng commented May 2, 2018 •

edited

BoPeng commented May 2, 2018 •

edited